home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d17 / doccon.arc / DOCUMENT.TXT < prev    next >
Text File  |  1989-03-10  |  17KB  |  378 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                              DOCUMENT CONTROL
  10.  
  11.  
  12.                  "In Real Life There will Always Be Paper"
  13.  
  14.  
  15.  
  16.                               Steve Griffiths
  17.                              S.G. Engineering
  18.                             2308 Barbara Drive
  19.                            Camarillo,  CA 93010
  20.                               (805) 388-8099
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27. Document Control Users Manual                                   Page #
  28.  
  29. Table of Contents.
  30.  
  31.         Introduction............................................Page 3
  32.  
  33.         Registration............................................Page 4
  34.  
  35.         Installation............................................Page 5
  36.  
  37.                 System Requirements
  38.  
  39.                 Copying Files
  40.  
  41.                 Config.Sys File
  42.  
  43.         Using Document Control..................................Page 6
  44.  
  45.                 Getting Started                                 Page 6
  46.  
  47.                 Menu Structure..................................Page 6
  48.  
  49.                 Keyword Window Menu.............................Page 6
  50.  
  51.                 Adding a Document...............................Page 7
  52.  
  53.                 Searching Documents.............................Page 8
  54.  
  55.                         By Keyword..............................Page 8
  56.  
  57.                         By Author...............................Page 8
  58.  
  59.                 Adding Keywords.................................Page 9
  60.  
  61.                 Archiving Documents.............................Page 9
  62.  
  63.                 Deleting Documents from Archive.................Page 9
  64.  
  65.              Document Control is designed create a simple yet effective
  66.     environment for keeping large quantities of paper documents in an
  67.     orderly manner, and to allow any combination of documents to be
  68.     retrieved with a minimum of effort.
  69.  
  70.              The basic premise of this application is to enter a number of
  71.     keywords describing the document (up to ten per document), along with
  72.     a brief description, author and date, at which point the computer will
  73.     issue a number to be attached to the document, which can then be filed
  74.     in numerical sequence. To find a document, or collection of documents,
  75.     enter the relevant keywords and receive either a printout or screen
  76.     display of all documents matching those particular keywords, along with
  77.     the description, author and date of entry. Alternatively the document
  78.     file may be searched by the author, and in both cases the search may be
  79.     limited to a specific date range. The Menu Structure of Document
  80.     Control is designed to allow extremely fast entry of keywords, both for
  81.     adding and searching for documents. A keyword need only be entered
  82.     once. After a keyword has been entered, it is available in a pop-up
  83.     lightbar menu. When adding documents to the system keywords may be
  84.     entered "on the fly" as required with no previous planning.
  85.  
  86.              There are many advantages to this type of system. Firstly,
  87.     only one copy of each document is required, no matter how many projects
  88.     it may relate to. Because of this there is no risk of one copy being
  89.     updated with others being out of date and causing confusion. Secondly,
  90.     if a document is updated it is easy to see which is the current version
  91.     as it will have the higher number. Thirdly, because documents are
  92.     stored in a totally random fashion, the physical filing cabinets
  93.     maintain a certain amount of security, in that a person looking
  94.     through the files can make no sense out of the information without
  95.     spending a considerable amount of time.
  96.  
  97.              To keep search time to a minimum, "dead" documents relating to
  98.     finished projects etc. may be moved to a separate archive file. If
  99.     necessary this file may also be searched in the same manner. Documents
  100.     that are completely "dead" - i.e. in the trash can - may be deleted
  101.     from the archive file.
  102.  
  103.  
  104.  
  105.     Registration
  106.  
  107.         Document Control is a Shareware Product, which allows the user to
  108.     "Try before You Buy" an application. To register the product print out
  109.     the registration form by typing "TYPE REGISTER.DOC > PRN" (no quotes
  110.     required. Fill the form out and send it in. Registered users will
  111.     receive the registered version of Document Control, along with complete
  112.     documentation, and telephone support. In addition, registered users
  113.     will be notified of upgrades, which will be made available for a
  114.     nominal handling charge.
  115.  
  116.         The Unregistered version of document control is not restricted in
  117.     any fashion, and may be put to full use. However, the registered
  118.     version does have some additional features including those listed
  119.     below.
  120.  
  121.     1) Opening Screen is Removed
  122.  
  123.     2) Registered Version is Serialized
  124.  
  125.     3) Password Protection is included as an option
  126.  
  127.     4) Documents may be deleted from Archive File
  128.  
  129.     When Should I Register?
  130.  
  131.         A Shareware product should be registered if it becomes an
  132.     application that is used on a regular or semi-regular basis. Running
  133.     the application for a couple of weeks is no problem. I it does not do
  134.     what you want, pass it on to a friend. If you decide to use it, then it
  135.     should be registered. Please remember, Shareware allows people to pick
  136.     and choose their software carefully, and for the most part at a very
  137.     reasonable cost. If people do not register their products, the concept
  138.     may not survive.
  139.  
  140.  
  141.  
  142.  
  143.     Installation
  144.  
  145.     System Requirements.
  146.  
  147.              Document Control requires an IBM (or true compatible) PC, XT,
  148.     AT or 386 Computer with at least 256K of TPA (Transient Program Area).
  149.     This is the amount of memory left after DOS and any Memory Resident
  150.     programs, device drivers etc. have been loaded. The program will run
  151.     under DOS 2.10 or higher. Also a Hard Disk is required.
  152.  
  153.     Copying Files
  154.  
  155.              To install the system onto a hard disk, firstly switch to the
  156.     directory to which the files are to be copied. Place the distribution
  157.     disk in drive A: and type "COPY A:*.*" (Do not include the quotes.)
  158.  
  159.  
  160.     Config.Sys File
  161.  
  162.              To use Document Control, there must be three lines in the
  163.     Config.Sys file. These are as Follows:-
  164.  
  165.                         FILES=20
  166.                         BUFFERS=22
  167.                         DEVICE=ANSI.SYS
  168.  
  169.     If you already have a Config.sys file, these lines may be added using
  170.     any ASCII word processor. If there is no Config.sys file, switch to the
  171.     root directory (floppy disk users should place the DOS Boot disk into
  172.     Drive a: and switch to it) and type the following:-
  173.  
  174.                         COPY CON CONFIG.SYS
  175.                         FILES=20
  176.                         BUFFERS=22
  177.                         DEVICE=ANSI.SYS
  178.                         ^Z
  179.  
  180.     (^Z means hold down the Control key and press the Z key, and then the
  181.     Enter key)
  182.  
  183.         Now re-boot the computer and Document Control will be ready to run.
  184.  
  185.     Using Document Control
  186.  
  187.     Getting Started.
  188.  
  189.     To run Document Control, switch to the directory containing the files
  190.     and type "DOCUMENT" (No Quotes Required). After displaying an opening
  191.     screen, the main menu will be displayed.
  192.  
  193.     Menu Structure
  194.  
  195.              Document Control uses window menus with a highlight bar. To
  196.     select an option, either move the bar using the UP or DOWN Cursor Keys
  197.     to highlight the choice desired and press return, or simply press the
  198.     first letter of your choice (all Menu choices have unique first
  199.     letters). Most of the Main Menu choices will bring up a sub-menu, which
  200.     works in the same manner. When this is the case, the highlight bar on
  201.     the Main Menu will remain at the choice made, so that it is east to find
  202.     out where you have come from. To return from a sub-menu to a higher
  203.     menu, press the escape key.
  204.  
  205.     Keyword Menu Window.
  206.  
  207.              When adding documents to the system, or when searching for
  208.     documents using Keyword Selection, the Keyword Selection Window will
  209.     appear. The window is similar to the regular menus with some additional
  210.     features. The window will display the first 16 Keywords (in
  211.     alphabetical order. Use the following keys to move around:-
  212.  
  213.         UP Arrow                Move Highlight up by one Keyword
  214.         DOWN Arrow              Move Highlight down by one Keyword
  215.         HOME Key                Top Keyword in Display
  216.         END Key                 Last Keyword in Display
  217.         PAGE UP                 Previous 16 Keywords
  218.         PAGE DOWN               Next 16 Keywords
  219.         CTRL + PAGE UP          First 16 Keywords
  220.         CTRL + PAGE DOWN        Last 16 Keywords
  221.         a - z   OR
  222.         A - Z   OR
  223.         0 - 9                   First Keyword with a matching first
  224.                                 Letter or Number. (If there are no matches
  225.                                 the highlight bar will not move).
  226.  
  227.  
  228.  
  229.  
  230.     Using Document Control
  231.  
  232.         Adding a Document
  233.  
  234.              To add a Document to the system, select "Add Document" from
  235.     the main menu by highlighting this selection or by pressing "A" (This
  236.     may be lower or upper case). Two windows will appear. The first is the
  237.     Keyword Select Menu described above, and next to this is another window
  238.     which will display selected keywords as they are chosen.
  239.  
  240.              To select keywords, move the highlight bar to the keyword
  241.     desired using the methods described above and press return.
  242.  
  243.     TIP:- The fastest method of finding a keyword is to start by pressing
  244.           the first letter of the keyword desired and then scrolling
  245.           through the keywords.
  246.  
  247.              If the keyword that you wish to use is not available, press
  248.     the ESCAPE key. A third window will open and prompt for a keyword.
  249.     Enter the new keyword (upper or lower case), press Return and the
  250.     highlight will return to the Keyword Selection window. At this point,
  251.     the new keyword is not visible, but as soon as you look for it again it
  252.     will appear, in the correct alphabetical position. After each keyword
  253.     is selected, it will appear in the "Selected Keyword" window, and the
  254.     highlight bar will return to the empty position at the top of the
  255.     Keyword Selection window.
  256.  
  257.              When all the desired keywords (up to 10 per Document) have
  258.     been chosen, make sure that the highlight is in the empty space and
  259.     press the return key. A third window will appear and prompt for the
  260.     author of the document and for a short additional description.
  261.  
  262.     TIP:- Something must be entered into both these fields. Because
  263.           Document Control allows a fast search by Author, this field can
  264.           alternatively be used as a secondary keyword for batching
  265.           projects etc. Also the authors name can be a regular keyword like
  266.           any other.
  267.  
  268.              After the Author and Description have been filled in this
  269.     window will be replaced with the "Document I.D." window, which contains
  270.     the number assigned to this document. Identify the document with the
  271.     number and file it. (Adding Documents using the system is much faster
  272.     than reading this page of instructions). As an aid to searching for
  273.     documents, the date that the document was entered is also stored with
  274.     the rest of the information.
  275.  
  276.  
  277.         Searching Documents.
  278.  
  279.           By Keyword
  280.  
  281.         Select "Search Documents" from the main menu, and a sub-menu will
  282.     appear. Select "Keyword Search" from this menu, and the Keyword Select
  283.     and Keywords Chosen windows will appear. Choose the desired keywords
  284.     (See "Adding Documents" for more information) and then press return.
  285.     A third window will appear, allowing a Date Range to be set (the
  286.     default is from the earliest document to the current date), and to
  287.     allow the information to be routed to the screen or the printer.
  288.         Once this is done, a listing will appear of all documents that
  289.     match the search criteria, showing the Document number, the Date of
  290.     Entry, the Author, and the Description. Now it is a simple matter of
  291.     going to the filing cabinet and pulling the documents with the numbers
  292.     shown on the list.
  293.  
  294.     NOTE 1:- The search is based on an .AND. basis, meaning that ALL the
  295.     selected keywords have to match a document for it to be displayed. In
  296.     short, the more keywords chosen, the narrower the search will be.
  297.     However, the search time is a constant of about 3 seconds per 100
  298.     records. Setting a date range will shorten the search time.
  299.  
  300.     NOTE 2:- If the document that you are looking for is not displayed, but
  301.     you know it is in there somewhere - i.e. you can't remember the
  302.     keyword(s), press return at the keyword selection window without
  303.     selecting any keywords. This will display ALL documents in the
  304.     specified date range.
  305.  
  306.         Searching Documents.
  307.  
  308.           By Author
  309.  
  310.         Select "Author Search" from the Search menu. You will be prompted
  311.     for an Entry, and then for the Date Range and Display or Print option.
  312.     Once this is done, the matching documents will be displayed in the same
  313.     way as before.
  314.  
  315.     NOTE:- The difference between this and the keyword search is that this
  316.     is a high speed index search. For this reason, it can be a good idea to
  317.     type in a major keyword in the Author field, and to include the authors
  318.     name in the description field.
  319.  
  320.  
  321.  
  322.     Adding Keywords.
  323.  
  324.         This is a useful feature when the program has just been installed.
  325.     Select "New Keyword" from the main menu, and the New Keyword window
  326.     will appear. Type in the Keyword and press return. By adding a series
  327.     of common keywords in the early stages, documents may be added to the
  328.     system without adding keywords "on the fly".
  329.  
  330.     Archiving Documents
  331.  
  332.         After the system has been running for a few months, and documents
  333.     have been added daily, search times will start to get longer as the
  334.     database gets larger. (Bear in mind that it is still much faster than
  335.     searching through files by hand!). Many of the documents in the
  336.     database will be no longer necessary, unused until the end of the year,
  337.     or kept for historical purposes only. These documents may be Archived
  338.     to a separate database, thus keeping the current database smaller and
  339.     faster. The Archive file can be searched in the same way as the main
  340.     file, with the exception that the "Author Search" option is not
  341.     available at this time. (It may be added later if users request it.)
  342.  
  343.         To use the archive system select "Document Archives" from the main
  344.     menu, and then select "Move Documents from Archive" from the Sub-Menu.
  345.     A list of Documents starting from the oldest will appear, 1 page at a
  346.     time, with a strip to the left. Enter a "X" by each document to be
  347.     archived. After each page has been completed, the date of each document
  348.     selected will be replaced with the word "Archived". At this point you
  349.     will be prompted to go to the next page, or to press "X" if you have
  350.     finished. This will continue until the database reaches the last
  351.     record. At this point (or if "X" has been entered) the selected
  352.     documents will be moved to the archive file, deleted from the current
  353.     file, and both files will be re-indexed. All document numbers will be
  354.     unchanged, so there is no need to move the "Real" Documents.
  355.  
  356.     NOTE:- To maintain the numerical integrity of the document files, it
  357.     is not possible to archive the last entry in the current document file.
  358.  
  359.     Deleting Documents from Archive.
  360.  
  361.         This feature uses exactly the same interface as is used when
  362.     moving Documents to the Archive. Select "Document Archives" from the
  363.     Main Menu, and then select "Delete Documents from Archive" from the
  364.     Sub-Menu. A list of Documents starting from the oldest will appear, 1
  365.     page at a time, with a strip to the left. Enter a "X" by each document
  366.     to be archived. After each page has been completed, the date of each
  367.     document selected will be replaced with the word "Deleted". At this
  368.     point you will be prompted to go to the next page, or to press "X" if
  369.     you have finished. This will continue until the database reaches the
  370.     last record. At this point (or if "X" has been entered) the selected
  371.     documents will be deleted from the archive file. The Document numbers
  372.     that are deleted will not be reused.
  373.  
  374.     NOTE:- To maintain the numerical integrity of the document files, it
  375.     is not possible to delete the last entry in the archive document file.
  376.  
  377.  
  378.